API Documentation
Component.h
1 // Component.h
3 //
5 
6 namespace nkWinUi
7 {
12  {
13  public :
14 
22  Component (MainSystem* parentSystem) ;
26  virtual ~Component () ;
27 
28  // Getters
32  Layout* getLayout () const ;
36  Theme* getTheme () const ;
48  int getWidth () const ;
52  int getHeight () const ;
64  virtual nkMaths::Point getBorderExtents () const ;
71  virtual float getBorderExtent (BORDER_KIND border) const ;
75  virtual int getLayoutAllowedWidth () const ;
79  virtual int getLayoutAllowedHeight () const ;
83  virtual int getLayoutAllowedOffsetX () const ;
87  virtual int getLayoutAllowedOffsetY () const ;
90  bool isInitialized () const ;
106  bool getVisibility () const ;
110  virtual nkMemory::StringView getLabel () const ;
113  void* getData () const ;
117  bool isEnabled () const ;
121  bool isForegroundWindow () const ;
125  unsigned int getZDepth () const ;
129  bool getVisibleOnLoad () const ;
133  std::function<bool (Component*)> getCloseCallback () const ;
137  std::function<void (Component*, bool)> getVisibilityCallback () const ;
141  std::function<void (Component*, const ClickEventData&)> getClickCallback () const ;
145  std::function<void (Component*, const WheelEventData&)> getWheelCallback () const ;
149  std::function<void (Component*, const KeyEventData&)> getKeyCallback () const ;
150 
151  // Setters
161  virtual Layout* setLayout (LAYOUT_TYPE layoutType) ;
169  virtual void setTheme (Theme* theme) ;
175  virtual void setPositionInParent (nkMaths::Point position) ;
181  virtual void setPositionInScreen (nkMaths::Point position) ;
188  virtual void setSize (int width, int height) ;
194  virtual void setWidth (int width) ;
200  virtual void setHeight (int height) ;
207  void setMinSize (unsigned int width, unsigned int height) ;
214  void setMaxSize (unsigned int width, unsigned int height) ;
220  void setRatio (float widthOverHeight) ;
226  virtual void setAreaInParent (const nkMaths::Rectangle& area) ;
232  virtual void setAreaInScreen (const nkMaths::Rectangle& area) ;
239  virtual void setParentComponent (Component* parent, bool makeItVisible = true) ;
246  virtual void setLabel (const nkMemory::StringView& label) ;
260  virtual void setVisibility (bool value) ;
268  void setData (void* data) ;
276  void setEnabled (bool value) ;
283  void setVisibleOnLoad (bool value) ;
290  void setCloseCallback (std::function<bool (Component* caller)> callback) ;
296  void setVisibilityCallback (std::function<void (Component* caller, bool visibility)> callback) ;
302  void setClickCallback (std::function<void (Component* caller, const ClickEventData& eventData)> callback) ;
308  void setWheelCallback (std::function<void (Component* caller, const WheelEventData& eventData)> callback) ;
314  void setKeyCallback (std::function<void (Component* caller, const KeyEventData& eventData)> callback) ;
315 
322  void addChild (Component* child, bool makeItVisible = true) ;
328  void removeChild (Component* child) ;
336  void removeChild (unsigned int index) ;
343  Component* getChild (unsigned int index) ;
352  unsigned int getChildIndex (Component* child) ;
364  void updateZDepth () ;
365 
373  void focusWindow () ;
374 
389 
394  virtual void load () = 0 ;
399  virtual void unload () = 0 ;
404  void reload () ;
405 
409  virtual void updateWindow () ;
410 
426  nkImages::Image paintToImage (bool withFrame = false) ;
427 
435  void simulateEvent (const InputDescriptor& inputDescription) ;
439  void onSized () ;
440 
446  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
453  virtual void exportIntrospection (nkExport::Node* rootNode) ;
459  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
460  } ;
461 }
nkWinUi::Component::isEnabled
bool isEnabled() const
nkWinUi::Component::updateWindow
virtual void updateWindow()
nkWinUi::ClickEventData
Data holder for a click event.
Definition: ClickEventData.h:12
nkWinUi::Component::setRatio
void setRatio(float widthOverHeight)
nkWinUi::Component::getPositionInScreen
nkMaths::Point getPositionInScreen() const
nkWinUi::KeyEventData
Data holder for a key event.
Definition: KeyEventData.h:12
nkWinUi::Component::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkWinUi::Component::getCloseCallback
std::function< bool(Component *)> getCloseCallback() const
nkWinUi::Component::setClickCallback
void setClickCallback(std::function< void(Component *caller, const ClickEventData &eventData)> callback)
nkWinUi::LAYOUT_TYPE
LAYOUT_TYPE
Defines the type of layout available.
Definition: LayoutType.h:12
nkWinUi::Component::setData
void setData(void *data)
nkWinUi::Component::setPositionInParent
virtual void setPositionInParent(nkMaths::Point position)
nkWinUi::Component::getTheme
Theme * getTheme() const
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkWinUi::Component::setVisibility
virtual void setVisibility(bool value)
nkWinUi::Component::getLayout
Layout * getLayout() const
nkWinUi::Component::Component
Component(MainSystem *parentSystem)
nkWinUi::Component::removeChild
void removeChild(unsigned int index)
nkWinUi::Component::getAreaInScreen
nkMaths::Rectangle getAreaInScreen() const
nkWinUi::Layout
Represents a layout to organize children of a component.
Definition: Layout.h:12
nkWinUi::Component::getWidth
int getWidth() const
nkWinUi::Component::paintToImage
nkImages::Image paintToImage(bool withFrame=false)
nkWinUi::Component::getCoordRelativeFromAbsolute
nkMaths::Point getCoordRelativeFromAbsolute(const nkMaths::Point &absCoords)
nkWinUi::Component::getCoordAbsoluteFromRelative
nkMaths::Point getCoordAbsoluteFromRelative(const nkMaths::Point &relCoords)
nkWinUi::Component::reload
void reload()
nkWinUi::Component::setHeight
virtual void setHeight(int height)
nkWinUi::Component::setAreaInParent
virtual void setAreaInParent(const nkMaths::Rectangle &area)
nkWinUi::Component::setMaxSize
void setMaxSize(unsigned int width, unsigned int height)
nkWinUi::Component::getZDepth
unsigned int getZDepth() const
nkWinUi::Component::getLayoutAllowedWidth
virtual int getLayoutAllowedWidth() const
nkWinUi::Component::simulateEvent
void simulateEvent(const InputDescriptor &inputDescription)
nkWinUi::Component::setLayout
virtual Layout * setLayout(LAYOUT_TYPE layoutType)
nkWinUi::Component::getAreaInParent
nkMaths::Rectangle getAreaInParent() const
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::Component::bringToForeground
void bringToForeground()
nkWinUi::Component::unloadWithChildren
void unloadWithChildren()
nkWinUi::Component::setComponentName
void setComponentName(const nkMemory::StringView &name)
nkWinUi::Component::setEnabled
void setEnabled(bool value)
nkWinUi::Component::setTheme
virtual void setTheme(Theme *theme)
nkWinUi::Component::isInitialized
bool isInitialized() const
nkWinUi::Component::setVisibleOnLoad
void setVisibleOnLoad(bool value)
nkWinUi::Component::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkWinUi::Component::setParentComponent
virtual void setParentComponent(Component *parent, bool makeItVisible=true)
nkWinUi::Component::getKeyCallback
std::function< void(Component *, const KeyEventData &)> getKeyCallback() const
nkWinUi::Component::getParentComponent
Component * getParentComponent() const
nkWinUi::Component::getVisibilityCallback
std::function< void(Component *, bool)> getVisibilityCallback() const
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkWinUi::COMPONENT_TYPE
COMPONENT_TYPE
Available component types.
Definition: ComponentType.h:12
nkWinUi::Component::getHeight
int getHeight() const
nkWinUi::MainSystem
The main system of the component.
Definition: MainSystem.h:18
nkWinUi::Component::setAreaInScreen
virtual void setAreaInScreen(const nkMaths::Rectangle &area)
nkWinUi::Component::getBorderExtents
virtual nkMaths::Point getBorderExtents() const
nkWinUi::Component::getComponentType
COMPONENT_TYPE getComponentType() const
nkWinUi::Component::getLabel
virtual nkMemory::StringView getLabel() const
nkWinUi::Component::setPositionInScreen
virtual void setPositionInScreen(nkMaths::Point position)
nkMaths::Point
Represents a 2D Point.
Definition: Point.h:12
nkWinUi::Component::getData
void * getData() const
nkWinUi::Component::setWheelCallback
void setWheelCallback(std::function< void(Component *caller, const WheelEventData &eventData)> callback)
nkWinUi::Component::setCloseCallback
void setCloseCallback(std::function< bool(Component *caller)> callback)
nkWinUi::Component::getChild
Component * getChild(unsigned int index)
nkWinUi::Component::getLayoutAllowedHeight
virtual int getLayoutAllowedHeight() const
nkWinUi::Component::setMinSize
void setMinSize(unsigned int width, unsigned int height)
nkWinUi::Component::setLabel
virtual void setLabel(const nkMemory::StringView &label)
nkWinUi::Component::focusWindow
void focusWindow()
nkWinUi::Component::setSize
virtual void setSize(int width, int height)
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkWinUi::Component::getLayoutAllowedOffsetX
virtual int getLayoutAllowedOffsetX() const
nkWinUi::Component::setKeyCallback
void setKeyCallback(std::function< void(Component *caller, const KeyEventData &eventData)> callback)
nkWinUi::Component::isForegroundWindow
bool isForegroundWindow() const
nkWinUi::Component::loadWithChildren
void loadWithChildren()
nkWinUi::Theme
A theme used to style the windows in the component.
Definition: Theme.h:44
nkWinUi::Component::onSized
void onSized()
nkWinUi::Component::getVisibility
bool getVisibility() const
nkWinUi::Component::getWheelCallback
std::function< void(Component *, const WheelEventData &)> getWheelCallback() const
nkWinUi::InputDescriptor
Describes an input event.
Definition: InputDescriptor.h:14
nkWinUi::Component::exportIntrospection
virtual void exportIntrospection(nkExport::Node *rootNode)
nkWinUi::Component::load
virtual void load()=0
nkWinUi::Component::getComponentName
nkMemory::StringView getComponentName() const
nkWinUi::BORDER_KIND
BORDER_KIND
Lists borders kind around components.
Definition: BorderKind.h:12
nkMaths::Rectangle
Represents a 2D rectangle.
Definition: Rectangle.h:12
nkWinUi::Component::getBorderExtent
virtual float getBorderExtent(BORDER_KIND border) const
nkWinUi::Component::getPositionInParent
nkMaths::Point getPositionInParent() const
nkWinUi::WheelEventData
Data holder for a wheel event.
Definition: WheelEventData.h:12
nkWinUi::Component::~Component
virtual ~Component()
nkWinUi::Component::removeChild
void removeChild(Component *child)
nkWinUi::Component::getVisibleOnLoad
bool getVisibleOnLoad() const
nkWinUi::Component::updateZDepth
void updateZDepth()
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Button.h:7
nkWinUi::Component::unload
virtual void unload()=0
nkWinUi::Component::getLayoutAllowedOffsetY
virtual int getLayoutAllowedOffsetY() const
nkWinUi::Component::addChild
void addChild(Component *child, bool makeItVisible=true)
nkImages::Image
Holds all information required for an image, with ownership over the data.
Definition: Image.h:14
nkWinUi::Component::setWidth
virtual void setWidth(int width)
nkWinUi::Component::getClickCallback
std::function< void(Component *, const ClickEventData &)> getClickCallback() const
nkWinUi::Component::getChildIndex
unsigned int getChildIndex(Component *child)
nkWinUi::Component::setVisibilityCallback
void setVisibilityCallback(std::function< void(Component *caller, bool visibility)> callback)